Provides IconFamily data for a specified IconSuite.

OSErr IconSuiteToIconFamily (
    IconSuiteRef iconSuite, 
    IconSelectorValue whichIcons, 
    IconFamilyHandle *iconFamily
);

Parameter descriptions

iconSuite

The IconSuiteRef to use as a source for icon data.

whichIcons

The depths and sizes of icons to extract from the iconFamily data structure. For a description of the possible values, see “Icon Selector Constants”.

iconFamily

On return, a pointer to a handle to the structure which contains icon data as specified in the iconSuite and whichIcons parameters. Icon Services returns NULL if no appropriate icon data is found. For more information on the IconFamily data structure, see 'icns'.

function result

A result code.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.5 or later.

© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)